home *** CD-ROM | disk | FTP | other *** search
/ CU Amiga Super CD-ROM 4 / CU Amiga Magazine's Super CD-ROM 04 (1996)(EMAP Images)(GB)(Track 1 of 3)[!][issue 1996-11].iso / magazine / psion / utils / shell25.lzx / SHELL25.DOC < prev    next >
Text File  |  2016-01-30  |  15KB  |  390 lines
  1. SHELL v2.5 ... a Shell for Psion Series 3a .. by Marko Schuster 1994
  2.  
  3. NEWS: look at the end of this file!
  4.  
  5. NOTE : Cause my english is not SO good, this doc is not a 100% translation
  6.        from my german-doc. If you have problems, may be it helps if you
  7.        read the german text, perhaps you can find the answer of your
  8.        question ...
  9.        (The program is 100% english!)
  10.        
  11.                     
  12.                     0. Copyright
  13.  
  14. This Version of Shell is not public domain, but freely distributable.
  15. This means that I have the copyright, but you can use it without paying
  16. money for it. You can give the prg. to your friends, you can upload it
  17. in your BBS, but you are NOT allowed to make money with it.
  18.  
  19. If you find bugs or have any suggestions .. let me know.
  20.  
  21.  
  22.                     1. WHY A SHELL?
  23.                     
  24. Well.. the Series3a-"Workbench" (You'll see, I have an Amiga (even 2 :-) ))
  25. is very good, but a few things I've missed and so I programmed the Shell.
  26.  
  27.  
  28.                     2. WHAT CAN I DO WITH THE SHELL?
  29.                     
  30. (not translated from the german doc)
  31. Simply try it out! :-)
  32.  
  33.  
  34.                     3. HOW I WORK WITH THE SHELL?
  35.                     
  36. Simply enter the commands :-). This is handled by the OPL-Command "EDIT".
  37. If you press ESC on an empty line, you can get the last line typed.
  38. It is a little Buffer with 9 lines. Instead this you can enter the command
  39. "+" which let you select the line you want to edit with a dialog.
  40. The command "+" will not be add to the buffer!
  41.  
  42. Redirection: with v2.5 you can redirect the output to a file by typing
  43. >file directly after the command before its arguements! A NIL: or NUL:
  44. can be choosen for no output. Example: dir >dir.txt M:\opl\ writes
  45. all filenames in the directory M:\opl\ to the file dir.txt. 
  46.  
  47.                     
  48.                     4. Hints
  49.                     
  50. You MUST have the prg. "EXPWIN2.OPA" und your M:\APP\-Directory.
  51. This is a little exploding-windows-hack which is used by shell and may
  52. be used in your own programmes!
  53. If a batch-file 'M:\autoexec.bat' exisits, it will be exucted on every start
  54. of shell. (In it you can have e.g. PROMPT and FONT - commands ..)
  55. In the archive there is also an alias-file of WORD, named ed_bat.als,
  56. a true ascii-editor. It can be used to edit/make *.bat files (in the
  57. \bat\ - directory). To edit autoexec.bat, press TAB and open the file
  58. autoexec.bat from M:\
  59. If a command doesn't exist, it is searched in the directories \OPO, \APP
  60. and \BAT if there exists a file named command+.OPO/OPA/BAT and if this
  61. is true it will be loaded, if it is a OPO or OPA, or executed, if it is
  62. a BAT - file. To start a OPO or OPA - prg. you must then enter the procedure
  63. which you want to start, followed by a ":" as you would do it in OPL.
  64. Warning: When the current directory is on REM:: it will be searched on REM::A,
  65. REM::B: and REM::M: ..
  66.  
  67. You can get the argument-list of a command by entering the command WITHOUT
  68. any argument, so don't use -? or /? as you would do it in a 'normal' dos/
  69. shell! !!  Example: COPY would print COPY <source> <dest>
  70.  
  71.                     
  72.                     5. Available Commands
  73.  
  74. You must at least enter the letters shown here in caps, e.g. RemDir,
  75. you can enter REMDIR or RD (you can also type ReMdIr or rd or rD ..)
  76. Between arguments there must be at least 1 space. But type NO space
  77. in an argument! This makes problems by files, which have spaces. Simply
  78. replace the space with the wildcard "?" (you can also use the wildcard "*"
  79. for 1-xx chars, but for more information consult the programming manual on
  80. page 41)
  81.  
  82. Output on screen can be paused by pressing CTRL-S (every OPL-prg. allow
  83. you to do this!)
  84.  
  85. +
  86.         Display buffer-list and let you select the line you want to edit,
  87.         ESC to abort.
  88.  
  89. *
  90.         Shell goes in background        
  91.  
  92. ?      
  93.         lists all available commands
  94.         
  95. #
  96.         = DIAL, for more informations, see on DIAL
  97.         
  98. ;<comment>
  99.         To insert a comment. Useful for batchfiles.
  100.         Example: ;this is a comment-line
  101.                  
  102. <proc>: [<argument>]
  103.         Starts the procedure <proc>. ONE argument is allowed optionally.
  104.         Beispiel:  TEST:     equal to OPL  TEST:
  105.                    TEST: ab  equal to OPL  TEST:("ab")
  106.                    
  107. ALIAS [<alias_in> [<alias_out>]]
  108.         Shows and sets ALIASes. The Alias is <alias_in>, the command
  109.         <alias_out> is the real command. The alias alias_in may be up
  110.         to 10 chars, the alias_out up to 128. Max. 20 aliases may be
  111.         used. Look in the batch UNIX.BAT for an example for UNIX-users.
  112.         A good place for aliases is the M:\autoexec.bat.
  113.         ALIAS without any options lists all aliases, ALIAS with one
  114.         option lists the command that will be executed by alias_in.
  115.         A @ may be set in the alias_out to get the options from the
  116.         line typed in with the alias.
  117.         Examples:
  118.         ALIAS c copy @    - will set alias c to "copy @". Now you
  119.         can type e.g. "c test1.opl test1.bak" instead of "copy test1.opl
  120.         test1.bak". "ALIAS C" would type out "copy @". 
  121.  
  122. [CD] <path>
  123.         change the current directory. Be sure to add a "\" on the
  124.         end of the directory-name. Example: Instead of CD \OPL you
  125.         must type CD \OPL\ !! One exception: CD A: would change to
  126.         the current directory on A:
  127.         !! You can NOT use a ".." for the parent dir as you would use
  128.         it on a PC !! .. perhaps in future versions :-)
  129.         If the path is not a command or a existing file, you can also
  130.         enter the paths without "CD" .. also the path must end with
  131.         an \ or ::
  132.         Example: current path = M:\OPL\ 
  133.                        cd a:
  134.                  new path = A:\OPL\
  135.                  or without CD:   \APP\
  136.  
  137. ChangeTaskPri <process-id> <priority>
  138.         Changes the priority of the task with given process-id to
  139.         priority. Until know, I don't know how to get the priority
  140.         of a task, only set it :) .. BTW: the S3a sets special prio's
  141.         for example if moving a running OPO-prg. to background.
  142.  
  143. CLS     the screen will be cleared...
  144.  
  145. COPY <source> <dest>
  146.         Copy the file source to dest. Dest may be a file or a directory.
  147.         If you use wildcards, there is NO output, which file is copied!
  148.         Example: current path = M:\AGN\
  149.                         copy agenda.agn agenda.bak    (backup)
  150.                         copy agenda.agn a:            (copy to 
  151.                                                        A:\AGN\Agenda.agn)
  152.                                                        
  153. DATE    the date an time in the format WWW TT MMM JJJJ SS:MM:SS aus.
  154.         Example: Sat 15 May 1993 22:20:54
  155.         it's equal to the command TIME..
  156.     
  157. Dir [<path>]
  158.         shows the directory of the current path or the specified <path>.
  159.         you can also add files and/or wildcards to the path, e.g.
  160.         DIR a*.* .
  161.         The DIR-Command is not yet font-sensitive, so the columns may be
  162.         look very funny with some fonts (it is correct with font 1, 4, 5,
  163.         10, 11, 13, 8225 (8225 are the small caps used in the spreadsheet)
  164.         .. if you want to see subdirectories .. use command SDir
  165.         .. if you want to see date/time/attribs .. use command LDir
  166.         
  167. DELete  <file>
  168.         deletes the file <file>. Whole directories can be deleted by
  169.         DELete *.* .
  170.         
  171. DIAL <number>
  172.         Dials a number. Be sure not to type spaces between the numbers!
  173.         It's equal to the command #. The # - char can be also found by
  174.         pressing the HELP-Key!
  175.         erreichen kann!
  176.         Example: DIAL 3942*39AB#
  177.                   # 2093
  178.  
  179. ECHO [<text>]
  180.         Prints the text text on the screen. If there is no text, make a
  181.         new line. Useful for batchfiles.
  182.  
  183. EVAL <term>
  184.         calculates the mathematical expression <term>. The output is decimal.
  185.         Example: EVAL 2*&F    .. = 30
  186.         
  187. EXecute <batch>
  188.         executes the batchfile 'batch'. If it can be found in the \BAT\
  189.         or current directory, you can enter the filename without EXecute.
  190.         Example: ex \test.bat    .. executes the batch-file '\test.bat'
  191.                   ed      .. executes the batchfile ed.bat if it can be
  192.                              found in \BAT\ or the current dir.
  193.  
  194. eXit
  195.         exits the shell.. equal to Quit
  196.  
  197. Font <font-id> [<style>]
  198.         Change font. The available standard-fonts will be listet if you
  199.         enter Font without an argument. Style is the Style of the font.
  200.         On proportional fonts, you should use 16 for non-proportional.
  201.         Example: f 5 16
  202.   
  203. HELP
  204.         shows a small help..
  205.  
  206. INFO [<dev>]
  207.         shows infos about the current device or dev
  208.         (name, size, free bytes)
  209.         Example: INFO ROM::    or INFO M:
  210.  
  211. LDir [<path>]
  212.         shows directory with file-dates, -times and -attributes.
  213.         Also it uses only 1 entry per line (yet!).
  214.  
  215. Load <OPO/OPA-File>
  216.         loads a OPO or OPA file to memory. If the file can be found
  217.         in \OPO\, \OPA\ or the current dir, you mustn't type Load..
  218.         Example: L test.opo
  219.         To start a procedure see the ":"-command.
  220.         
  221. LoadFont <font-filename> 
  222.         loads a font into memory and prints its ID.
  223.         Example: lf M:\fon\script.fon   .. prints -16377
  224.                   f -16377 16            .. change the font
  225.                   
  226. MakeDir <path>
  227.         Erstellt ein Verzeichnis
  228.         Example: md \pic    .. erstellt das Verzeichnis \PIC
  229.  
  230. MEM     prints free memory in bytes
  231.  
  232. MOVE <source> <dest>
  233.         Equal to the commands COPY and DELETE.
  234.         Example: move *.opo A:
  235.         
  236. PAUSE <delay>
  237.         Equal to the OPL-Command PAUSE. A 0 will wait for a key.
  238.  
  239. Play <file> [<duration>]
  240.         Plays a WVE-File created by the Recorder.
  241.         Aborted if you press any key.
  242.         Example: p rom::sys$al01.wve
  243.  
  244. PROMPT <prompt>
  245.         changes the prompt. following strings can be used additionaly:
  246.          %B = Backspace, deletes the last char
  247.          %D = Day of the week
  248.          %E = Name of the day of the week
  249.          %F = shows free memory in bytes (MEM!)
  250.          %H = Hour
  251.          %I = Minute
  252.          %K = Waits for a keypress
  253.          %M = Month
  254.          %N = New line       
  255.          %O = Name of the Month
  256.          %P = Current path
  257.          %S = Second
  258.          %Txx= Style, MUST be 2 chars!. 02=underline 04=invert 32=italic
  259.          %W = Week
  260.          %Y = Year (4 chars)
  261.          %Z = Year (2 chars)
  262.         Example:  prompt [%e%b, %d.%m.%z / %h:%i:%s]%n%p >
  263.                    .. results for example:
  264.                    [Fr, 01.10.93 / 13:45:26]
  265.                    M:\OPL\ >
  266.                    
  267. Quit
  268.         Quits the shell .. equal to eXit
  269.  
  270. RemDir <path>
  271.         Deletes a (empty) directory
  272.         Example: rd M:\opl\tests   .. deletes M:\opl\tests
  273.         
  274. REName <old> <new>
  275.         Rename a programme with the OLD-name to the NEW-name
  276.         The new name can contain a path, if it is on the same disk.
  277.         Example: ren test.txt imprtnt.txt
  278.                  ren \opl\shell.opl \opl\tools\shell.opl
  279.                   
  280. Run <opo-file> 
  281.         starts a OPO-File as it would done by RUNOPL .. 
  282.         It doesn't halt the shell, that means you can use the
  283.         shell immediately after the Run-Command without exiting
  284.         the runned prg(s) ! 
  285.  
  286.  
  287. SET [<var> [<value>]]
  288.         Sets the variable VAR to VALUE. In this version, there is only
  289.         allowed to set UNIX to ON or OFF. UNIX ON means, that / are
  290.         converted to \ in an commandline. So you can type your pathes
  291.         with / instead of \ (Example: ls M:/OPL/ if LS is an alias to dir)
  292.         This may be usefull for UNIX and AMIGA - Users ...
  293.         Not converted are / in the commands ECHO, PROMPT, ALIAS and EVAL.
  294.         In a next version you will be able to set more vars and to
  295.         read & use them in your batch-files.
  296.  
  297. SDir [<path>]
  298.         Shows the current dir or the one specified and its subdirs and
  299.         subdirs and so on.
  300.         Example: SD M:\
  301.  
  302. TASKS
  303.         shows all tasks and their process-ids
  304.  
  305. TIME
  306.         Equal to DATE and prints the current date and time.
  307.  
  308. Type <filename> [HEX]
  309.         Types a text-file. If HEX is specified, it will be shown in
  310.         HEX and ASCII. (This is font-sensitive !!)
  311.         Example: type M:\autoexec.bat
  312.                  t rom::agenda.app hex
  313.                   
  314. UnLoad <OPO-File>
  315.         A loaded OPO/OPA-file will be unloaded.
  316.  
  317. UnloadFont <font-id>
  318.         The loaded font with the ID specified will be unloaded.
  319.         Example: uf -16377
  320.         
  321. View <filename> [<x> <y>] [<bitmap>] [Grey]
  322.         Views a Pic. X/Y = length/height of the pic. On a 'normal'
  323.         PIC-File (the first bytes of it are PIC - you can see this if
  324.         you type a pic hex ...) the length/height is read from the
  325.         file. But this won't work on APP or IMG - Files e.g. .
  326.         bitmap = the bitmap which should be loaded
  327.         Grey = the next bitmap will be loaded to the grey-plane.
  328.         Example: view \pic\psion.pic
  329.                  view \pic\psion.pic grey
  330.                  view \pic\psion.pic 40 80
  331.                  view rom::world.app 400 120 2
  332.                  v rom::sys$shll.img 4
  333.                  v rom::sys$wsrv.img 60 50 4 g
  334.                   
  335.  
  336.                     6. FUTURE VERSIONS ..
  337.                     
  338. DIR - font-sensitive, options, no LDIR/SDIR any more ...
  339.  
  340. Batchfiles with arguments
  341.  
  342. Allow ".." in filenames
  343.  
  344. check a filename given at RUN what kind of file it is and start
  345. then the application for it. For example RUN xxx.wrd would start
  346. the word.application with filename xxx.wrd.
  347.  
  348.                     
  349.                     7. How to contact me
  350.                     
  351. * via Email to  ns103@fim.uni-erlangen.de
  352. * German people can also call my BBS (see german dok) .. it is 100% in
  353.   german an there's no english text, so it makes no sense if you call it,
  354.   sorry..
  355. * A voice call is also too expensive (number can be found in the german
  356.   DOK-File), but you can write to me:
  357.   Marko Schuster
  358.   Helmstraáe 23
  359.   D-90419 Nrnberg
  360.   Germany
  361.  
  362.                     
  363.                     8. History         
  364.  
  365. v2.5   * new command: TASKS - shows tasks & her process-id
  366.        * new command: ChangeTaskPri - changes priority of tasks
  367.        * Type doesn't worked on V2.4x .. no it works (& even faster :) )
  368.        * wildcards can be used now with PLAY and VIEW
  369.        * copy/delete/move: filenames are shown (wildcards!)
  370.        * redirection of output to file (or NIL: / NUL: for no output)
  371.  
  372. v2.44  * ALIAS-command
  373.        * Executing a batch from a batch will work now.
  374.        * SET UNIX ON to convert / to \ in commandlines
  375.        * MEM shows free memory in bytes
  376.        * INFO shows Infos about devices
  377.        * new in PROMPT: %F shows free memory
  378.                             
  379. v2.43  * New LDIR-Command .. lists file-date,time&attribute
  380.        * New ed_bat.als in the archive
  381.        
  382. v2.42  * RUN opo-files
  383.        * ststistics in DIR and SDIR
  384.        * no CD-try on 'unknown command'
  385.  
  386. v2.41  * Play doesn't played the given filename
  387.        * CD is no longer needed
  388.        
  389.  
  390.